Doc string clarification.

* subr.el (match-string): Mention that the current buffer should
be the same as the search was done in.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index c7adf3869d19d41d454c8a0b3007e92244b6ba00..e2c0038d3250f5827db748e10e2a99b1791b9cb7 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2011-09-11  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
+       * subr.el (match-string): Mention that the current buffer should
+       be the same as the search was done in (bug#9282).
+
        * facemenu.el: Disable the remove-* commands if the mark isn't
        active (bug#9162).
 

diff --git a/lisp/subr.el b/lisp/subr.el
index a2676b1173d7798d1659a9fddee593db61fba99b..35fac1fe8f2bb9e4f02f893605d3ce6657506d64 100644 (file)
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -3249,7 +3249,9 @@ The value returned is the value of the last form in BODY."
 NUM specifies which parenthesized expression in the last regexp.
  Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
 Zero means the entire text matched by the whole regexp or whole string.
-STRING should be given if the last search was by `string-match' on STRING."
+STRING should be given if the last search was by `string-match' on STRING.
+If STRING is nil, the current buffer should be the same buffer
+the search/match was performed in."
   (if (match-beginning num)
       (if string
          (substring string (match-beginning num) (match-end num))
@@ -3260,7 +3262,9 @@ STRING should be given if the last search was by `string-match' on STRING."
 NUM specifies which parenthesized expression in the last regexp.
  Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
 Zero means the entire text matched by the whole regexp or whole string.
-STRING should be given if the last search was by `string-match' on STRING."
+STRING should be given if the last search was by `string-match' on STRING.
+If STRING is nil, the current buffer should be the same buffer
+the search/match was performed in."
   (if (match-beginning num)
       (if string
          (substring-no-properties string (match-beginning num)